logo
API docs by Redocly

Catalog Management REST Service (1.41)

Download OpenAPI specification:Download

The Catalog Management API provides developers a way to manage their product catalog.

System Integrity

Resources related to System Integrity.

Health Check

Use to check whether or not the Catalog Management system is up and running.

Authorizations:
SWT

Responses

Assignment Template

Resources related to Assignment Templates.

Search Assignment Template

Search for Assignment Templates in the system. [Rev 1.35]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : assignmentTemplateID, name
  • Sortable : assignmentTemplateID, name
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Broadband Label

Resources related to the management of Broadband Labels.

Search Broadband Label Fee Types

Search for Broadband Label Fee Types in the system. [Rev 1.30]

Available Fields

The following is a list of fields for a Broadband Label Fee Type and how they can be used within a search.

  • Filterable : BroadbandLabelFeeTypeID, Description
  • Sortable : BroadbandLabelFeeTypeID, Description
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Create a Broadband Label

Create a Broadband Label. [Rev 1.30]

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
additionalDataCharge
required
decimal

Additional data charge

additionalDataIncrement
integer

Additional data increment

Array of objects (CreateBroadbandLabelFee)

Fees associated to the broadband label

contractLength
integer

Length of the contract

contractTermsURL
string

URL to the contract terms

dataAllowancePolicyURL
string

URL to the data allowance policy

discountBundleURL
string

URL to the discount bundle

downloadSpeed
required
string

Download speed

endDate
date-time

End date of the plan

eTFFee
decimal

The ETF fee

eTFFeeURL
string

URL to the ETF fee

hasETF
required
boolean

Whether or not there is an ETF

hasIntroRate
required
boolean

Whether or not the plan has an intro rate

includesUnlimitedData
required
boolean

Whether or not the plan includes unlimited data

introRate
decimal

The intro rate

introRateDuration
integer

Duration of the intro rate

isMobileServiceType
required
boolean

Is the service type of the policy mobile

latency
required
integer

Latency

linkToDiscountBundle
required
boolean

Whether or not there is a link to a discount bundle

monthlyDataAllowance
integer

The monthly data allowance

monthlyPrice
required
decimal

Monthly price for the plan

name
required
string

Name of the broadband label

ntwkMgmtPolicyURL
string

URL to the network management policy

planDataDescription
string

Description of the plan data

planDataURL
string

URL to plan data

privacyPolicyURL
string

URL to the privacy policy

providerFCCRegNumber
required
string

FCC regulation number for the provider

providerName
required
string

Name of the service provider

requiresContract
required
boolean

Whether or not the plan requires a contract

servicePlanName
required
string

Name of the service plan

showPlanDataInfo
required
boolean

Whether or not to show plan data info

startDate
required
date-time

Start date of the plan

supportURL
string

URL to the support page

supportURLDisplay
string

Display text of the support URL

supportNumber
string

Phone number to the support line

tierPlanName
string

Name of the tier plan

uniquePlanNumber
required
string

Unique number for the plan

uploadSpeed
required
string

Upload speed

Responses

Request samples

Content type
application/json
{
  • "additionalDataCharge": 99.99,
  • "additionalDataIncrement": 5,
  • "broadbandLabelfees": [
    ],
  • "contractLength": 11,
  • "contractTermsURL": "contractterms.com",
  • "dataAllowancePolicyURL": "dataallowancepolicy.com",
  • "discountBundleURL": "discountbundle.com",
  • "downloadSpeed": "50mbps",
  • "endDate": "2019-04-21 11:33:52",
  • "eTFFee": 13.99,
  • "eTFFeeURL": "etffee.com",
  • "hasETF": true,
  • "hasIntroRate": true,
  • "includesUnlimitedData": false,
  • "introRate": 1.99,
  • "introRateDuration": 10,
  • "isMobileServiceType": true,
  • "latency": 1,
  • "linkToDiscountBundle": true,
  • "monthlyDataAllowance": 2,
  • "monthlyPrice": 12.99,
  • "name": "Broadband Label",
  • "ntwkMgmtPolicyURL": "network.com",
  • "planDataDescription": "Description",
  • "planDataURL": "plandata.com",
  • "privacyPolicyURL": "privacypolicy.com",
  • "providerFCCRegNumber": "123-A",
  • "providerName": "Provider",
  • "requiresContract": true,
  • "servicePlanName": "Service Plan",
  • "showPlanDataInfo": true,
  • "startDate": "2019-04-21 11:33:52",
  • "supportURL": "support.com",
  • "supportURLDisplay": "Need support?",
  • "supportNumber": "111-222-3333",
  • "tierPlanName": "Tier 1",
  • "uniquePlanNumber": "001",
  • "uploadSpeed": "11mbps"
}

Response samples

Content type
application/json
{
  • "additionalDataCharge": 99.99,
  • "additionalDataIncrement": 5,
  • "broadbandLabelFees": [
    ],
  • "broadbandLabelID": 1,
  • "contractLength": 11,
  • "contractTermsURL": "contractterms.com",
  • "createDate": "2024-07-16T09:18:05.6059371-04:00",
  • "createdByUsername": "jdoe",
  • "dataAllowancePolicyURL": "dataallowancepolicy.com",
  • "discountBundleURL": "discountbundle.com",
  • "downloadSpeed": "50mbps",
  • "endDate": "2019-04-21 11:33:52",
  • "eTFFee": 13.99,
  • "eTFFeeURL": "etffee.com",
  • "hasETF": true,
  • "hasIntroRate": true,
  • "includesUnlimitedData": false,
  • "introRate": 1.99,
  • "introRateDuration": 10,
  • "isMobileServiceType": true,
  • "lastModifiedDate": "2024-07-16T09:18:05.6059371-04:00",
  • "lastModifiedUsername": "jdoe",
  • "latency": 1,
  • "linkToDiscountBundle": true,
  • "monthlyDataAllowance": 2,
  • "monthlyPrice": 12.99,
  • "name": "Broadband Label",
  • "ntwkMgmtPolicyURL": "network.com",
  • "planDataDescription": "Description",
  • "planDataURL": "plandata.com",
  • "privacyPolicyURL": "privacypolicy.com",
  • "providerFCCRegNumber": "123-A",
  • "providerName": "Provider",
  • "requiresContract": true,
  • "servicePlanName": "Service Plan",
  • "showPlanDataInfo": true,
  • "startDate": "2019-04-21 11:33:52",
  • "supportURL": "support.com",
  • "supportURLDisplay": "Need support?",
  • "supportNumber": "111-222-3333",
  • "tierPlanName": "Tier 1",
  • "uniquePlanNumber": "001",
  • "uploadSpeed": "11mbps"
}

Search Broadband Labels

Search for Broadband Labels in the system. [Rev 1.30]

Available Fields

The following is a list of fields for a Broadband Label and how they can be used within a search.

  • Filterable : BroadbandLabelID, Name
  • Sortable : BroadbandLabelID, Name
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Get a Broadband Label

Get a Broadband Label. [Rev 1.30]

path Parameters
broadbandLabelID
required
integer

Unique ID of the broadband label to retrieve.

Responses

Response samples

Content type
application/json
{
  • "additionalDataCharge": 99.99,
  • "additionalDataIncrement": 5,
  • "broadbandLabelFees": [
    ],
  • "broadbandLabelID": 1,
  • "contractLength": 11,
  • "contractTermsURL": "contractterms.com",
  • "createDate": "2024-07-16T09:18:05.6059371-04:00",
  • "createdByUsername": "jdoe",
  • "dataAllowancePolicyURL": "dataallowancepolicy.com",
  • "discountBundleURL": "discountbundle.com",
  • "downloadSpeed": "50mbps",
  • "endDate": "2019-04-21 11:33:52",
  • "eTFFee": 13.99,
  • "eTFFeeURL": "etffee.com",
  • "hasETF": true,
  • "hasIntroRate": true,
  • "includesUnlimitedData": false,
  • "introRate": 1.99,
  • "introRateDuration": 10,
  • "isMobileServiceType": true,
  • "lastModifiedDate": "2024-07-16T09:18:05.6059371-04:00",
  • "lastModifiedUsername": "jdoe",
  • "latency": 1,
  • "linkToDiscountBundle": true,
  • "monthlyDataAllowance": 2,
  • "monthlyPrice": 12.99,
  • "name": "Broadband Label",
  • "ntwkMgmtPolicyURL": "network.com",
  • "planDataDescription": "Description",
  • "planDataURL": "plandata.com",
  • "privacyPolicyURL": "privacypolicy.com",
  • "providerFCCRegNumber": "123-A",
  • "providerName": "Provider",
  • "requiresContract": true,
  • "servicePlanName": "Service Plan",
  • "showPlanDataInfo": true,
  • "startDate": "2019-04-21 11:33:52",
  • "supportURL": "support.com",
  • "supportURLDisplay": "Need support?",
  • "supportNumber": "111-222-3333",
  • "tierPlanName": "Tier 1",
  • "uniquePlanNumber": "001",
  • "uploadSpeed": "11mbps"
}

Update a Broadband Label

Updates a specific Broadband Label by ID. [Rev 1.30]

Note

  • This operation uses the JSON Patch document structure for specifying updates to a Broadband Label, which you can read more about here: JSON Patch (RFC 6902).

  • After JSON Patch validation, field validation is performed the same as Create a Broadband Label.

Patchable Fields

Allowed patch operations for each patchable property of a device.

  • name : add, replace

  • startDate : add, replace

  • endDate : add, remove, replace

  • providerName : add, replace

  • servicePlanName : add, replace

  • providerFCCRegNumber : add, replace

  • tierPlanName : add, remove, replace

  • uniquePlanNumber : add, replace

  • hasIntroRate : add, replace

  • introRate : add, remove, replace

  • introRateDuration : add, remove, replace

  • requiresContract : add, replace

  • contractLength : add, remove, replace

  • contractTermsURL : add, remove, replace

  • hasETF : add, replace

  • etfFee : add, remove, replace

  • etfFeeURL : add, remove, replace

  • linkToDiscountBundle : add, replace

  • discountBundleURL : add, remove, replace

  • includesUnlimitedData : add, replace

  • monthlyDataAllowance : add, remove, replace

  • monthlyPrice : add, replace [Rev 1.31]

  • additionalDataCharge : add, replace

  • additionalDataIncrement : add, remove, replace

  • dataAllowancePolicyURL : add, remove, replace

  • showPlanDataInfo : add, replace

  • planDataURL : add, remove, replace

  • planDataDescription : add, remove, replace

  • uploadSpeed : add, replace

  • downloadSpeed : add, replace

  • latency : add, replace

  • ntwkMgmtPolicyURL : add, remove, replace

  • privacyPolicyURL : add, remove, replace

  • supportURL : add, remove, replace

  • supportURLDisplay : add, remove, replace

  • supportNumber : add, remove, replace

  • isMobileServiceType : add, replace

  • addFees/#array : add

  • removeFeeIDs/#array : add

Authorizations:
SWT
path Parameters
broadbandLabelID
required
string

Unique ID for the Broadband Label.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get a Broadband Label by Service ID

Get a Broadband Label by Service ID. [Rev 1.30]

path Parameters
usgSvcID
required
integer

Unique ID of the service to retrieve a broadband label for.

Responses

Response samples

Content type
application/json
{
  • "additionalDataCharge": 99.99,
  • "additionalDataIncrement": 5,
  • "broadbandLabelFees": [
    ],
  • "broadbandLabelID": 1,
  • "contractLength": 11,
  • "contractTermsURL": "contractterms.com",
  • "createDate": "2024-07-16T09:18:05.6059371-04:00",
  • "createdByUsername": "jdoe",
  • "dataAllowancePolicyURL": "dataallowancepolicy.com",
  • "discountBundleURL": "discountbundle.com",
  • "downloadSpeed": "50mbps",
  • "endDate": "2019-04-21 11:33:52",
  • "eTFFee": 13.99,
  • "eTFFeeURL": "etffee.com",
  • "hasETF": true,
  • "hasIntroRate": true,
  • "includesUnlimitedData": false,
  • "introRate": 1.99,
  • "introRateDuration": 10,
  • "isMobileServiceType": true,
  • "lastModifiedDate": "2024-07-16T09:18:05.6059371-04:00",
  • "lastModifiedUsername": "jdoe",
  • "latency": 1,
  • "linkToDiscountBundle": true,
  • "monthlyDataAllowance": 2,
  • "monthlyPrice": 12.99,
  • "name": "Broadband Label",
  • "ntwkMgmtPolicyURL": "network.com",
  • "planDataDescription": "Description",
  • "planDataURL": "plandata.com",
  • "privacyPolicyURL": "privacypolicy.com",
  • "providerFCCRegNumber": "123-A",
  • "providerName": "Provider",
  • "requiresContract": true,
  • "servicePlanName": "Service Plan",
  • "showPlanDataInfo": true,
  • "startDate": "2019-04-21 11:33:52",
  • "supportURL": "support.com",
  • "supportURLDisplay": "Need support?",
  • "supportNumber": "111-222-3333",
  • "tierPlanName": "Tier 1",
  • "uniquePlanNumber": "001",
  • "uploadSpeed": "11mbps"
}

Get Broadband Label Product Associations

Get Products associated with a Broadband Label. [Rev 1.28]

path Parameters
broadbandLabelID
required
integer

Unique ID of the broadband label to retrieve associated products for.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Broadband Label Product Associations

Updates a specific Broadband Labels product associations. [Rev 1.28]

Note

  • This operation uses the JSON Patch document structure for specifying updates to a Broadband Label, which you can read more about here: JSON Patch (RFC 6902).

  • After JSON Patch validation, field validation is performed the same as Create a Broadband Label.

Patchable Fields

Allowed patch operations for each patchable property of a device.

  • addCatalogEntryIDs/#array : add
  • removeCatalogEntryIDs/#array : add
Authorizations:
SWT
path Parameters
broadbandLabelID
required
string

Unique ID for the Broadband Label.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Browse Tag

Resources related to Browse Tags.

Get Browse Tag

Retrieve a specific Browse Tag by ID. [Rev 1.35]

Authorizations:
SWT
path Parameters
browseTagID
required
integer

Unique ID of the Browse Tag to retrieve.

Responses

Response samples

Content type
application/json
{
  • "browseTagCategory": "Handset",
  • "browseTagCategoryID": 1,
  • "browseTagID": 1,
  • "displayAsChild": true,
  • "displayAsRoot": true,
  • "isAutoGenerated": false,
  • "name": "Handset"
}

Search Browse Tags

Search for Browse Tags in the system. [Rev 1.35]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : browseTagID, browseTagCategoryID, name
  • Sortable : browseTagID, name
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Browse Tag Category

Resources related to Browse Tag Categories.

Get a Browse Tag Category

Retrieve a specific Browse Tag Category by ID. [Rev 1.35]

Authorizations:
SWT
path Parameters
browseTagCategoryID
required
integer

Unique ID of the Browse Tag Category to retrieve.

Responses

Response samples

Content type
application/json
{
  • "browseTagCategoryID": 1,
  • "displayName": "Select feature(s)",
  • "isAccountLevel": true,
  • "name": "Feature",
  • "rank": 1
}

Update a Browse Tag Category

Update a specific Browse Tag Category by ID. [Rev 1.36]

Authorizations:
SWT
path Parameters
browseTagCategoryID
required
integer

Unique ID of the Browse Tag Category to update.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
displayName
string

Display name for the Browse Tag Category.

isAccountLevel
boolean

If true, the Browse Tag Category is displayed when browsing at the account level and not the service level.

name
required
string

Name of the Browse Tag Category.

rank
required
integer

Rank of the Browse Tag Category.

Responses

Request samples

Content type
application/json
{
  • "displayName": "Select feature(s)",
  • "isAccountLevel": true,
  • "name": "Feature",
  • "rank": 1
}

Response samples

Content type
application/json
{
  • "browseTagCategoryID": 1,
  • "displayName": "Select feature(s)",
  • "isAccountLevel": true,
  • "name": "Feature",
  • "rank": 1
}

Create Browse Tag Category

Create a Browse Tag Category. [Rev 1.35]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
displayName
string

Display name for the Browse Tag Category.

isAccountLevel
boolean

If true, the Browse Tag Category is displayed when browsing at the account level and not the service level.

name
required
string

Name of the Browse Tag Category.

rank
required
integer

Rank of the Browse Tag Category.

Responses

Request samples

Content type
application/json
{
  • "displayName": "Select feature(s)",
  • "isAccountLevel": true,
  • "name": "Feature",
  • "rank": 1
}

Response samples

Content type
application/json
{
  • "browseTagCategoryID": 1,
  • "displayName": "Select feature(s)",
  • "isAccountLevel": true,
  • "name": "Feature",
  • "rank": 1
}

Search Browse Tag Categories

Search for Browse Tag Categories in the system. [Rev 1.35]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : browseTagCategoryID, isAccountLevel, name
  • Sortable : browseTagCategoryID, isAccountLevel, name
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Catalog Entry

Resources related to Catalog Entry searching.

Search Catalog Entry

Search for catalog entries in the system.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : billingCycleType, billingCycleTypeID, catalogEntryID, description, endDate, isOnePricePackage, isTaxByComponent, productSubTypeID, productTypeID, sku, startDate, productCatalogClassID
  • Sortable : description, endDate, sku
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

List Catalog Entry Tree

Returns the hierarchy of items for a particular catalog entry. This will include the root level catalog entry and its entire set of children. [Rev 1.03]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : catalogEntryID, depth, description, endDate, isOnePriceChild, path, productCatalogClassID, productSubTypeID, productTypeID, sku, startDate
  • Sortable : depth, description, endDate, isOnePriceChild, path, sku
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

E911

Resources related to the management of E911.

Create E911 Company

Create an E911 Company. [Rev 1.21]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
companyID
string

Unique identifier for the company.

companyName
string

Name of the E911 company.

isDefault
boolean

Indicates whether or not the E911 company is the default for the company.

Responses

Request samples

Content type
application/json
{
  • "companyID": "ID111",
  • "companyName": "E911 company name",
  • "isDefault": true
}

Response samples

Content type
application/json
{
  • "companyID": "ID111",
  • "companyName": "E911 company name",
  • "e911CompanyID": 1,
  • "isDefault": true
}

Search E911 Companies

Search for E911 Companies in the system. [Rev 1.21]

Available Fields

The following is a list of fields for an E911 company and how they can be used within a search.

  • Filterable : companyID, companyName, e911CompanyID, isDefault
  • Sortable : companyID, companyName, e911CompanyID, isDefault
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Update an E911 Company

Updates a specific E911 company by ID. [Rev 1.21]

Note

  • This operation uses the JSON Patch document structure for specifying updates to a E911 Company, which you can read more about here: JSON Patch (RFC 6902).

  • After JSON Patch validation, field validation is performed the same as Create an E911 Company.

Patchable Fields

Allowed patch operations for each patchable property of a device.

  • companyID : add, replace

  • companyName : add, replace

  • isDefault : add, replace

Authorizations:
SWT
path Parameters
e911CompanyID
required
string

Unique ID for the E911 Company.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get an E911 Company

Retrieve a specific E911 company by ID. [Rev 1.21]

Authorizations:
SWT
path Parameters
e911CompanyID
required
integer

Unique ID of the E911 company to retrieve.

Responses

Response samples

Content type
application/json
{
  • "companyID": "ID111",
  • "companyName": "E911 company name",
  • "e911CompanyID": 1,
  • "isDefault": true
}

Create E911 ExcludeNpaNxx record

Create an E911 ExcludeNpaNxx Record. [Rev 1.21]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
npaNxx
string

the E911 ExcludeNpaNxx number.

Responses

Request samples

Content type
application/json
{
  • "npaNxx": "1234"
}

Response samples

Content type
application/json
{
  • "e911ExcludeNpaNxxID": 1,
  • "npaNxx": "1234"
}

Search E911 ExcludeNpaNxx

Search for E911 ExcludeNpaNxx in the system. [Rev 1.21]

Available Fields

The following is a list of fields for an E911 Exclude NpaNxx and how they can be used within a search.

  • Filterable : npaNxx
  • Sortable : npaNxx
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Update an E911 ExcludeNpaNxx

Updates a specific E911 ExcludeNpaNxx by ID. [Rev 1.21]

Note

Patchable Fields

Allowed patch operations for each patchable property of a device.

  • e911ExcludeNpaNxxID : add, replace

  • npaNxx : add, replace

Authorizations:
SWT
path Parameters
e911ExcludeNpaNxxID
required
string

Unique ID for the E911 ExcludeNpaNxx.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get an E911 ExcludeNpaNxx

Retrieve a specific E911 ExcludeNpaNxx by ID. [Rev 1.21]

Authorizations:
SWT
path Parameters
e911ProviderID
required
integer

Unique ID of the E911 ExcludeNpaNxx to retrieve.

Responses

Response samples

Content type
application/json
{
  • "e911ExcludeNpaNxxID": 1,
  • "npaNxx": "1234"
}

Create E911 Provider

Create an E911 Provider. [Rev 1.21]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
description
string

description for the E911 provider.

e911ProviderFileFormatID
integer

Unique identifier for the E911 provider file format.

Responses

Request samples

Content type
application/json
{
  • "description": "1234",
  • "e911ProviderFileFormatID": 1
}

Response samples

Content type
application/json
{
  • "description": "1234",
  • "e911ProviderID": 1,
  • "e911ProviderFileFormatID": 1,
  • "fileFormatDescription": "Sprint Format"
}

Search E911 Provider

Search for E911 Provider in the system. [Rev 1.21]

Available Fields

The following is a list of fields for an E911 provider and how they can be used within a search.

  • Filterable : Description, E911ProviderID, E911ProviderFileFormatID
  • Sortable : Description, E911ProviderID, E911ProviderFileFormatID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Update an E911 Provider

Updates a specific E911 provider by ID. [Rev 1.21]

Note

Patchable Fields

Allowed patch operations for each patchable property of a device.

  • description : add, replace

  • e911ProviderFileFormatID : add, replace

Authorizations:
SWT
path Parameters
e911ProviderID
required
string

Unique ID for the E911 Provider.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get an E911 Provider

Retrieve a specific E911 provider by ID. [Rev 1.21]

Authorizations:
SWT
path Parameters
e911ProviderID
required
integer

Unique ID of the E911 provider to retrieve.

Responses

Response samples

Content type
application/json
{
  • "description": "1234",
  • "e911ProviderID": 1,
  • "e911ProviderFileFormatID": 1,
  • "fileFormatDescription": "Sprint Format"
}

E-Rate

Resources related to E-Rate.

Create E-Rate FRN

Create an E-Rate FRN. [Rev 1.15]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
applicationNumber
required
string

Application Number for the E-Rate FRN

approvedAmount
required
decimal

Approved amount of the E-Rate FRN

billingSvcTypeID
integer

ID of the Billing Service type associated to the E-Rate FRN

description
string

Description associated to the E-Rate FRN

discountPercentage
required
int

Discount percentage of the E-Rate FRN

endDate
required
date-time

End date of the E-Rate FRN

frn
required
string

The Funding Request Number associated to the E-Rate FRN

serviceProviderID
required
string

Unique number assigned to the service provider

serviceProviderName
required
string

Name of the service provider associated to the E-Rate FRN

startDate
required
date-time

Start date of the E-Rate FRN

Responses

Request samples

Content type
application/json
{
  • "applicationNumber": "222222222",
  • "approvedAmount": 100,
  • "billingSvcTypeID": 1008,
  • "description": true,
  • "discountPercentage": 25,
  • "endDate": "2016-09-09T17:35:09.156Z",
  • "frn": "0029407442a",
  • "serviceProviderID": "258777444",
  • "serviceProviderName": "The Provider",
  • "startDate": "2015-09-09T17:35:09.156Z"
}

Response samples

Content type
application/json
{
  • "applicationNumber": "222222222",
  • "approvedAmount": 110.1,
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "username",
  • "description": "FRN description",
  • "discountPercentage": 25,
  • "endDate": "2016-09-09T17:35:09.156Z",
  • "eRateFRNID": 1008,
  • "featurelessBillingProgramID": 1,
  • "frn": "aa124",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "username",
  • "productSKU": "Test Product",
  • "productDescription": "E-Rate Discount",
  • "remainingAmount": 99.9,
  • "serviceProviderID": "2587774j44",
  • "serviceProviderName": "The Provider",
  • "startDate": "2015-09-09T17:35:09.156Z"
}

Search E-Rate FRNs

Search for E-RateFRNs in the system. [Rev 1.16]

Available Fields

The following is a list of fields for an E-Rate FRN and how they can be used within a search.

  • Filterable : FRN, ERateFRNID, StartDate, EndDate, ApplicationNumber, FeaturelessBillingProgramID, ProductSKU, ProductDescription
  • Sortable : FRN, ERateFRNID, StartDate, EndDate, CreateDate, ApplicationNumber, ServiceProviderID, ServiceProviderName, ApprovedAmount, DiscountPercentage, FeaturelessBillingProgramID, ProductSKU, ProductDescription
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Get E-Rate FRN

Retrieve a specific E-Rate FRN by ID. [Rev 1.15]

Authorizations:
SWT
path Parameters
FRNID
required
number
Example: 1

Unique identifier of the E-Rate FRN to retrieve.

Responses

Response samples

Content type
application/json
{
  • "applicationNumber": "222222222",
  • "approvedAmount": 110.1,
  • "createDate": "2016-09-09T17:35:09.156Z",
  • "createUser": "username",
  • "description": "FRN description",
  • "discountPercentage": 25,
  • "endDate": "2016-09-09T17:35:09.156Z",
  • "eRateFRNID": 1008,
  • "featurelessBillingProgramID": 1,
  • "frn": "aa124",
  • "lastModifiedDate": "2016-09-09T17:35:09.156Z",
  • "lastModifiedUser": "username",
  • "productSKU": "Test Product",
  • "productDescription": "E-Rate Discount",
  • "remainingAmount": 99.9,
  • "serviceProviderID": "2587774j44",
  • "serviceProviderName": "The Provider",
  • "startDate": "2015-09-09T17:35:09.156Z"
}

Update E-Rate FRN

Update a specific E-Rate FRN by ID. [Rev 1.16]

Note

  • This operation uses the JSON Patch document structure for specifying updates to an E-Rate FRN, which you can read more about here: JSON Patch (RFC 6902).

  • After JSON Patch validation, field validation is performed the same as Create ERateFRN.

Patchable Fields

Allowed patch operations for each patchable property of an E-Rate FRN.

  • FRN : add, replace

  • approvedAmount : add, replace

  • applicationNumber : add, replace

  • description : add, remove, replace

  • discountPercentage : add, replace

  • serviceProviderID : add, replace

  • serviceProviderName : add, replace

  • startDate : add, replace

  • endDate : add, replace

Authorizations:
SWT
path Parameters
erateFrnID
required
number
Example: 1

Unique identifier of the E-Rate FRN to update.

Request Body schema: application/json
Array
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Search E-Rate Products

Search for E-Rate Products assigned to an E-Rate FRN. [Rev 1.19]

Available Fields

The following is a list of fields for an E-Rate Product and how they can be used within a search.

  • Filterable : catalog, catalogEntryID, erateProductID, productTypeId
  • Sortable : catalog, catalogEntryID, erateProductID, productTypeId
path Parameters
erateFrnID
required
number
Example: 1

Unique identifier of the E-Rate FRN to retrieve products for.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Associate Products to E-Rate FRN

Associate E-Rate Products to an E-Rate FRN. [Rev 1.19]

Authorizations:
SWT
path Parameters
erateFrnID
required
number
Example: 1

Unique identifier of the E-Rate FRN to associate products to.

Request Body schema: application/json
Array
catalogEntryID
required
integer

Unique identifier for the associated catalog entry.

remove
boolean

Indicate that the product should be removed, instead of added. [Rev. 1.20]

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Search E-Rate Services

Search for E-Rate Services assigned to an E-Rate FRN. [Rev 1.20]

Available Fields

The following is a list of fields for an E-Rate Product and how they can be used within a search.

  • Filterable : accountNumber, customerID, customerName, erateServiceID, hasUtilization, lastModifiedDate, lastModifiedUser, serviceID, serviceNumber, serviceType
  • Sortable : accountNumber, customerID, customerName, erateServiceID, hasUtilization, lastModifiedDate, lastModifiedUser, serviceID, serviceNumber, serviceType
path Parameters
erateFrnID
required
number
Example: 1

Unique identifier of the E-Rate FRN to retrieve services for.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Assign Services to E-Rate FRN

Assign Services to an E-Rate FRN. [Rev 1.19]

Authorizations:
SWT
path Parameters
erateFrnID
required
number
Example: 1

Unique identifier of the E-Rate FRN to associate products to.

Request Body schema: application/json
Array
serviceID
required
integer

Unique identifier for the service.

remove
boolean

Indicate that the product should be removed, instead of added. [Rev. 1.20]

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Create E-Rate Utilization

Create an E-Rate Utilization. [Rev 1.16]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
customerID
required
int

The Customer ID of the E-Rate Utilization

date
required
date-time

The Date of the E-Rate Utilization

description
string

Description of the E-Rate Utilization [Rev 1.36]

discountAmount
required
decimal

The discount amount of the E-Rate Utilization

eligibleCharges
required
decimal

The eligible charges of the E-Rate Utilization

eRateFRNID
required
int

The E-Rate Utilization FRN ID of the E-Rate Utilization

eRateUtilizationFrequencyID
required
int

The E-Rate Utilization Frequency ID of the E-Rate Utilization

invoiceNumber
int

The invoice number of the E-Rate Utilization

serviceID
required
int

The usage service ID of the E-Rate Utilization

Responses

Request samples

Content type
application/json
{
  • "customerID": 10000,
  • "date": "2016-09-09T17:35:09.156Z",
  • "description": "sample description",
  • "discountAmount": 30,
  • "eligibleCharges": 500,
  • "eRateFRNID": 100,
  • "eRateUtilizationFrequencyID": 25,
  • "invoiceNumber": 29407442,
  • "serviceID": 10009
}

Search E-Rate Utilization

Search for E-Rate Utilization in the system. [Rev 1.16]

Available Fields

The following is a list of fields for an E-Rate Utilization and how they can be used within a search.

  • Filterable : ERateUtilizationID, ERateFRNID, FRN, Date, ERateUtilizationFrequencyID, CustomerID, AccountNumber, ServiceID, ServiceNumber, InvoiceNumber, EligibleCharges, DiscountAmount, DiscountPercent, BillPeriodID [Rev 1.19], ServiceProviderId [Rev 1.19]
  • Sortable : ERateUtilizationID, ERateFRNID, FRN, Date, ERateUtilizationFrequencyID, CustomerID, AccountNumber, ServiceID, ServiceNumber, InvoiceNumber, EligibleCharges, DiscountAmount, DiscountPercent, BillPeriodID [Rev 1.19], ServiceProviderId [Rev 1.19]
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Edit E-Rate Utilization

Edit an E-Rate Utilization in the environment. [Rev 1.18]

Note

  • This operation uses the JSON Patch document structure for specifying updates to an E-Rate FRN, which you can read more about here: JSON Patch (RFC 6902).

  • After JSON Patch validation, field validation is performed the same as Create ERateUtilization.

Patchable Fields

Allowed patch operations for each patchable property of an E-Rate FRN.

  • eligibleCharges : add, replace

  • erateUtilizationFrequencyID : add, replace

  • date : add, replace

  • discountAmount : add, replace

path Parameters
eRateUtilizationID
required
integer

System-generated unique identifier for the E-Rate Utilization to retrieve.

Request Body schema: application/json
Array
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "accountNumber": "2355611231",
  • "billPeriodEndDate": "2016-09-09T17:35:09.156Z",
  • "billPeriodID": 11090401,
  • "customerID": 10005,
  • "description": "sample description",
  • "discountAmount": 100,
  • "discountPercent": 5.5,
  • "eligibleCharges": 50,
  • "eRateUtilizationID": 1,
  • "eRateUtilizationFrequency": "ONE-TIME",
  • "eRateUtilizationFrequencyID": 5,
  • "eRateFRNID": 1008,
  • "frn": "aa124",
  • "invoiceNumber": "3466234223",
  • "serviceID": 1008,
  • "serviceNumber": "234532423425",
  • "serviceProviderID": "123456",
  • "serviceType": "Wireless",
  • "utilizationDate": "2016-09-09T17:35:09.156Z"
}

Delete E-Rate Utilization

Delete a E-Rate Utilization in the environment. [Rev 1.17]

Authorizations:
SWT
path Parameters
eRateUtilizationID
required
integer

System-generated unique identifier for the E-Rate Utilization to retrieve.

Responses

Response samples

Content type
application/json
{
  • "errors": {
    }
}

E-Rate Utilization Summary

Summarizes E-Rate Utilization information. [Rev 1.18]

Available Fields

The following is a list of fields for an E-Rate Utilization Summary and how they can be used within a search.

  • Filterable : ApplicationNumber, ServiceProviderNumber, ServiceProviderName, FRN
  • Sortable : ApplicationNumber, ServiceProviderNumber, ServiceProviderName, FRN
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Request Body schema: application/json
billPeriodID
integer

When supplied, filters the summary to include E-Rate Utilization for this bill period [Rev. 1.19]

fromUtilizationDate
date-time

When supplied, filters the summary to include E-Rate Utilization with a utilization date greater than or equal to this date

toUtilizationDate
date-time

When supplied, filters the summary to include E-Rate Utilization with a utilization date less than or equal to this date

Responses

Request samples

Content type
application/json
{
  • "billPeriodID": 11090401,
  • "fromUtilizationDate": "2016-01-01T17:35:09.156Z",
  • "toUtilizationDate": "2016-09-09T17:35:09.156Z"
}

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Search E-Rate Utilization Frequencies

Search for E-Rate Utilization Frequencies in the system. [Rev 1.16]

Available Fields

The following is a list of fields for an E-Rate Utilization Frequency and how they can be used within a search.

  • Filterable : ERateUtilizationFrequencyID, ERateUtilizationFrequency
  • Sortable : ERateUtilizationFrequencyID, ERateUtilizationFrequency
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Search E-Rate Customer Summary

Summarizes customer's E-Rate information per service. [Rev 1.20]

Available Fields

The following is a list of fields for an E-Rate Utilization Frequency and how they can be used within a search.

  • Filterable : ERateFRNID, FRN, FRNEndDate, FRNStartDate, ServiceID, ServiceNumber, ServiceType
  • Sortable : ERateFRNID, FRN, FRNEndDate, FRNStartDate, ServiceID, ServiceNumber, ServiceType
Authorizations:
SWT
path Parameters
customerID
required
number
Example: 1

Unique identifier of the customer to retrieve the summary for.

Responses

Response samples

Content type
application/json
{
  • "eRateFRNID": 1008,
  • "frn": "aa124",
  • "frnStartDate": "2015-09-09T17:35:09.156Z",
  • "frnEndDate": "2015-09-09T17:35:09.156Z",
  • "serviceID": 10,
  • "serviceNumber": 2122000005,
  • "serviceType": 2122000005
}

Featureless Billing Program

Resources related to FeaturelessBillingProgram.

Get FeaturelessBillingPrograms

Get FeaturelessBillingPrograms

Available Fields

The following is a list of fields for an E-Rate FRN and how they can be used within a search.

  • Filterable : FRN, ERateFRNID, StartDate, EndDate, ApplicationNumber, FeaturelessBillingProgramID, ProductSKU, ProductDescription
  • Sortable : FRN, ERateFRNID, StartDate, EndDate, CreateDate, ApplicationNumber, ServiceProviderID, ServiceProviderName, ApprovedAmount, DiscountPercentage, FeaturelessBillingProgramID, ProductSKU, ProductDescription
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Offering

Resources related to Offerings.

Search Offerings

Search for Offerings in the system. [Rev 1.36]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable: offeringID, broadbandLabelID, createDate, lastModifiedDate, lastModifiedUser, name, title
  • Sortable : offeringID, broadbandLabel, broadbandLabelID, createDate, lastModifiedDate, name, title
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Create Offering

Create an Offering. [Rev 1.36]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
broadbandLabelID
integer

Unique identifier for the Broadband Label to associate with the Offering.

highEmphasisText
string

High emphasis text of the Offering.

lowEmphasisText
string

Low emphasis text of the Offering.

name
required
string

Name of the Offering.

object (CreateOfferingHighlight)
offeringText
string

Descriptive text of the Offering.

title
required
string

Title of the Offering.

Responses

Request samples

Content type
application/json
{
  • "broadbandLabelID": 13,
  • "highEmphasisText": "$75 a month",
  • "lowEmphasisText": "12-month introductory rate",
  • "name": "Essential Offering",
  • "offeringHighlights": {
    },
  • "offeringText": "One great price for internet, TV, and phone! Pricing includes a discount for auto-pay. No term contract.",
  • "title": "High Speed Essential Bundle"
}

Response samples

Content type
application/json
{
  • "broadbandLabel": "string",
  • "broadbandLabelID": 13,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "bross",
  • "highEmphasisText": "$75 a month",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "string",
  • "lowEmphasisText": "12-month introductory rate",
  • "name": "Essential Offering",
  • "offeringHighlights": {
    },
  • "offeringID": 7,
  • "offeringText": "One great price for internet, TV, and phone! Pricing includes a discount for auto-pay. No term contract.",
  • "title": "High Speed Essential Bundle"
}

Get Offering

Retrieve a specific Offering by ID. [Rev 1.36]

Authorizations:
SWT
path Parameters
offeringID
required
integer

Unique ID of the Offering to retrieve.

Responses

Response samples

Content type
application/json
{
  • "broadbandLabel": "string",
  • "broadbandLabelID": 13,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "bross",
  • "highEmphasisText": "$75 a month",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "string",
  • "lowEmphasisText": "12-month introductory rate",
  • "name": "Essential Offering",
  • "offeringHighlights": {
    },
  • "offeringID": 7,
  • "offeringText": "One great price for internet, TV, and phone! Pricing includes a discount for auto-pay. No term contract.",
  • "title": "High Speed Essential Bundle"
}

Update an Offering

Update a specific Offering by ID and replace its Offering Highlights. [Rev 1.36]

Authorizations:
SWT
path Parameters
offeringID
required
integer

Unique ID of the Offering to update.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
broadbandLabelID
integer

Unique identifier for the Broadband Label to associate with the Offering.

highEmphasisText
string

High emphasis text of the Offering.

lowEmphasisText
string

Low emphasis text of the Offering.

name
required
string

Name of the Offering.

object (UpdateOfferingHighlight)
offeringText
string

Descriptive text of the Offering.

title
required
string

Title of the Offering.

Responses

Request samples

Content type
application/json
{
  • "broadbandLabelID": 13,
  • "highEmphasisText": "$75 a month",
  • "lowEmphasisText": "12-month introductory rate",
  • "name": "Essential Offering",
  • "offeringHighlights": {
    },
  • "offeringText": "One great price for internet, TV, and phone! Pricing includes a discount for auto-pay. No term contract.",
  • "title": "High Speed Essential Bundle"
}

Response samples

Content type
application/json
{
  • "broadbandLabel": "string",
  • "broadbandLabelID": 13,
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "bross",
  • "highEmphasisText": "$75 a month",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "string",
  • "lowEmphasisText": "12-month introductory rate",
  • "name": "Essential Offering",
  • "offeringHighlights": {
    },
  • "offeringID": 7,
  • "offeringText": "One great price for internet, TV, and phone! Pricing includes a discount for auto-pay. No term contract.",
  • "title": "High Speed Essential Bundle"
}

Search Offering Catalog Item Associations

Search for Catalog Items associated to an Offering in the system. [Rev 1.36]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : catalogID, offeringCatalogItemAssociationID, parentOfferingCatalogItemAssociationID, productTypeID
  • Sortable : catalog, catalogID, offeringCatalogItemAssociationID, productType, productTypeID
Authorizations:
SWT
path Parameters
offeringID
required
number
Example: 1

Unique identifier of the Offering to retrieve Catalog Items for.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Create Offering Catalog Item Association

Create an Offering Catalog Item Association. [Rev 1.36]

Authorizations:
SWT
path Parameters
offeringID
required
number
Example: 1

Unique identifier of the Offering the Catalog Item should be associated to.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
assignmentTemplateID
integer

Unique identifier for the Assignment Template.

catalogID
required
integer

Unique identifier for the Catalog Item.

parentOfferingCatalogItemAssociationID
integer

Unique identifier for the parent Offering Catalog Item Association.

Responses

Request samples

Content type
application/json
{
  • "assignmentTemplateID": 1,
  • "catalogID": 1,
  • "parentOfferingCatalogItemAssociationID": 1
}

Response samples

Content type
application/json
{
  • "assignmentTemplate": "Assignment Template",
  • "assignmentTemplateID": 1,
  • "catalog": "Catalog Item",
  • "catalogID": 1,
  • "offeringCatalogItemAssociationID": 1,
  • "parentOfferingCatalogItemAssociationID": 1,
  • "productType": "Product Type",
  • "productTypeID": 1,
  • "sku": "SKU12345"
}

Delete Offering Catalog Item Association

Delete a specific Offering Catalog Item Association and its child Offering Catalog Item Associations by ID. [Rev 1.36]

Authorizations:
SWT
path Parameters
offeringID
required
number
Example: 1

Unique identifier of the Offering the Catalog Item is associated to.

offeringCatalogItemAssociationID
required
number
Example: 1

Unique identifier of the Offering Catalog Item Association to delete.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Update Offering Catalog Item Association

Update a specific Offering Catalog Item Association by ID. [Rev 1.36]

Authorizations:
SWT
path Parameters
offeringID
required
number
Example: 1

Unique identifier of the Offering the Catalog Item is associated to.

offeringCatalogItemAssociationID
required
number
Example: 1

Unique identifier of the Offering Catalog Item Association to update.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
assignmentTemplateID
integer

Unique identifier for the Assignment Template.

catalogID
required
integer

Unique identifier for the Catalog Item.

parentOfferingCatalogItemAssociationID
integer

Unique identifier for the parent Offering Catalog Item Association.

Responses

Request samples

Content type
application/json
{
  • "assignmentTemplateID": 1,
  • "catalogID": 1,
  • "parentOfferingCatalogItemAssociationID": 1
}

Response samples

Content type
application/json
{
  • "assignmentTemplate": "Assignment Template",
  • "assignmentTemplateID": 1,
  • "catalog": "Catalog Item",
  • "catalogID": 1,
  • "offeringCatalogItemAssociationID": 1,
  • "parentOfferingCatalogItemAssociationID": 1,
  • "productType": "Product Type",
  • "productTypeID": 1,
  • "sku": "SKU12345"
}

Paperless Billing Configuration

Resources related to Paperless Billing Configuration. [Rev 1.24]

Add or update the Paperless Billing Incentive configuration

Add or Update a paperless billing configuration.

Note

CatalogID - Unique Identifier of the catalog entry that will be used by the Paperless Billing Incentive

  • Charge incentives only support one-time charge products.
  • Credit incentives only support Volume Discounts.
Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
catalogID
required
integer

Unique Identifier of the catalog entry that will be used by the Paperless Billing Incentive

isCharge
boolean

Determines the incentive type either a charge or a credit

isEnabled
boolean

Determines whether or not the Paperless Billing Incentive will apply or not

omittedAccountTypes
list

A list of all of the account type ID's that are omitted from the Paperless Billing Incentive.

requiresAutoPay
boolean

Only applies to credits, defaults to false if a charge. Determines if the credit requires autopay.

Responses

Request samples

Content type
application/json
{
  • "catalogID": 1,
  • "isCharge": true,
  • "isEnabled": true,
  • "omittedAccountTypes": [
    ],
  • "requiresAutoPay": false
}

Get Paperless Billing Incentive Configuration

Get a paperless billing incentive configuration [Rev 1.24]

Authorizations:
SWT

Responses

Response samples

Content type
application/json
{
  • "Configured": true,
  • "GlobalConfiguration": {
    }
}

Pricing Zone

Resources related to the management of Pricing Zones.

Search Pricing Zones

Search for Pricing Zones in the system. [Rev 1.39]

Available Fields

The following is a list of fields for a Pricing Zone and how they can be used within a search.

  • Filterable: pricingZoneID, description, stateAbbrev, stateID, stateName, assignmentTemplateID, assignmentTemplateName, zoneReference
  • Sortable: pricingZoneID, description, stateAbbrev, stateID, stateName, assignmentTemplateID, assignmentTemplateName, zoneReference
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq \"foo\"&$skip=50"
}

Create Pricing Zone

Create a new Pricing Zone in the system. [Rev 1.39]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json

The Pricing Zone to create.

description
required
string

Name of the pricing zone

stateID
required
integer

Identifier for the state associated with the pricing zone

assignmentTemplateID
integer

Identifier for the assignment template associated with the pricing zone

longDescription
string

Long description of the pricing zone

zoneReference
string

Unique reference code for the pricing zone [Rev 1.40]

Responses

Request samples

Content type
application/json
{
  • "description": "Residential Customers",
  • "stateID": 1,
  • "assignmentTemplateID": 1001,
  • "longDescription": "This zone applies to all residential customers in the specified state.",
  • "zoneReference": "ZONE-001"
}

Response samples

Content type
application/json
{
  • "pricingZoneID": 12345,
  • "description": "Residential Customers",
  • "stateID": 1,
  • "assignmentTemplateID": 1001,
  • "longDescription": "This zone applies to all residential customers in the specified state.",
  • "zoneReference": "ZONE-001"
}

Get a Pricing Zone

Retrieve a specific Pricing Zone by its ID. [Rev 1.40]

Authorizations:
SWT
path Parameters
pricingZoneID
required
integer

Unique identifier for the pricing zone

Responses

Response samples

Content type
application/json
{
  • "pricingZoneID": 12345,
  • "description": "Residential Customers",
  • "stateID": 1,
  • "assignmentTemplateID": 1001,
  • "longDescription": "This zone applies to all residential customers in the specified state.",
  • "zoneReference": "ZONE-001"
}

Delete a Pricing Zone

Delete a specific Pricing Zone by its ID. [Rev 1.40]

Authorizations:
SWT
path Parameters
pricingZoneID
required
integer

Unique identifier for the pricing zone

Responses

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Update a Pricing Zone

Update a specific Pricing Zone by its ID. [Rev 1.40]

Note

  • This operation uses the JSON Patch document structure for specifying updates to a Pricing Zone, which you can read more about here: JSON Patch (RFC 6902).

  • After JSON Patch validation, field validation is performed the same as Create a Pricing Zone.

Patchable Fields

Allowed patch operations for each patchable property of a device.

  • assignmentTemplateID : replace
  • description : replace
  • longDescription : replace
  • stateID : replace
  • zoneReference : replace
Authorizations:
SWT
path Parameters
pricingZoneID
required
integer

Unique identifier for the pricing zone

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
{
  • "op": "replace",
  • "path": "/description",
  • "value": 1000555
}

Response samples

Content type
application/json
{
  • "pricingZoneID": 12345,
  • "description": "Residential Customers",
  • "stateID": 1,
  • "assignmentTemplateID": 1001,
  • "longDescription": "This zone applies to all residential customers in the specified state.",
  • "zoneReference": "ZONE-001"
}

Product Catalog AdvancePay Price Point

Resources related to Product Catalog AdvancePay Price Points.

Search Product Catalog AdvancePay Price Point

Search for Product Catalog AdvancePay Price Points. [Rev 1.34]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : advancePayPricePointDefinitionID, catalogID, numberOfDays
  • Sortable : advancePayPricePointDefinitionID, catalogID, numberOfDays
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Product Catalog Group

Resources related to Product Catalog Groups.

Search Product Catalog Group Catalog Entries

Search for Catalog Entries in a Product Catalog Group. [Rev 1.37]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : billingCycleType, billingCycleTypeID, catalogEntryID, description, endDate, isOnePricePackage, isTaxByComponent, productSubTypeID, productTypeID, sku, startDate, productCatalogClassID
  • Sortable : description, endDate, sku
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Product Catalog Pricing

Resources related to Product Catalog Pricing.

Search Product Catalog Pricing

Search for Product Catalog Pricing in the system. [Rev 1.33]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : catalogID, contractCatalogID, npanxxZoneID, productCatalogPricingID
  • Sortable : catalogID, charge, contractCatalogID, cost, npanxxZoneID, productCatalogPricingID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Protection Plan Profile

Resources related to the management of protection plan profiles.

Create Protection Plan Profile

Create a protection plan profile. [Rev 1.04]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
description
string

Description for the protection plan profile.

name
required
string

Name of the protection plan profile.

protectionPlanProfileTypeID
integer

Unique identifier for the protection plan profile type.

provisioningEnabled
boolean

Inidcates whether or not the protection plan will send commands to a 3rd party system. This value will default to false if not specified.

object (ProvisioningSettings)
verificationRequired
boolean

Indicates whether or not the protection plan must be verified with a 3rd party system. [Rev 1.05]

Responses

Request samples

Content type
application/json
{
  • "description": "IPhone 11 Protection Plan covering accidental damage and theft.",
  • "name": "IPhone 11 Pay Up Front",
  • "protectionPlanProfileTypeID": 1,
  • "provisioningEnabled": true,
  • "provisioningSettings": {
    },
  • "verificationRequired": true
}

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "jdoe",
  • "description": "IPhone 11 Protection Plan covering accidental damage and theft.",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "string",
  • "name": "IPhone 11 Pay Up Front",
  • "protectionPlanProfileID": 1,
  • "protectionPlanProfileType": 1,
  • "protectionPlanProfileTypeID": 1,
  • "provisioningEnabled": true,
  • "provisioningSettings": {
    },
  • "verificationRequired": true
}

Search Protection Plan Profiles

Search for protection plan profiles in the system. [Rev 1.04]

Available Fields

The following is a list of fields for a protection plan profile and how they can be used within a search.

  • Filterable : createDate, createUser, description, lastModifiedDate, lastModifiedUser, name, protectionPlanProfileID, protectionPlanProfileTypeID
  • Sortable : createDate, createUser, description, lastModifiedDate, lastModifiedUser, name, protectionPlanProfileID, protectionPlanProfileType
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Update a Protection Plan Profile

Updates a specific protection plan profile by ID. [Rev 1.04]

Note

  • This operation uses the JSON Patch document structure for specifying updates to a Protection Plan Profile, which you can read more about here: JSON Patch (RFC 6902).

  • After JSON Patch validation, field validation is performed the same as Create a Protection Plan Profile.

Patchable Fields

Allowed patch operations for each patchable property of a device.

  • description : add, remove, replace

  • name : add, replace

  • protectionPlanProfileTypeID : add, remove, replace

  • provisioningEnabled : add, replace

  • provisioningSettings/cancelProvisioningProfileID : add, remove, replace

  • provisioningSettings/enrollProvisioningProfileID : add, remove, replace

  • provisioningSettings/provisionableObjectCode : add, remove, replace

  • provisioningSettings/queries : add, remove, replace [Rev 1.05]

  • provisioningSettings/suspendProvisioningProfileID : add, remove, replace [Rev 1.36]

  • provisioningSettings/verifyProvisioningProfileID : add, remove, replace [Rev 1.05]

  • verificationRequired : add, replace

Authorizations:
SWT
path Parameters
protectionPlanProfileID
required
string

Unique ID the protection plan profile.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get a Protection Plan Profile

Retrieve a specific protection plan profile by ID. [Rev 1.04]

Authorizations:
SWT
path Parameters
protectionPlanProfileID
required
integer

Unique ID of the Protection Plan Profile to retrieve.

Responses

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "jdoe",
  • "description": "IPhone 11 Protection Plan covering accidental damage and theft.",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "string",
  • "name": "IPhone 11 Pay Up Front",
  • "protectionPlanProfileID": 1,
  • "protectionPlanProfileType": 1,
  • "protectionPlanProfileTypeID": 1,
  • "provisioningEnabled": true,
  • "provisioningSettings": {
    },
  • "verificationRequired": true
}

List Protection Plan Profile Types

List the available protection plan profile types available to a profile.

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : name, protectionPlanProfileTypeID
  • Sortable : name, protectionPlanProfileTypeID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Update Code

Update all provisioning links using an existing provisionable object code to use a new provisionable object code.

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
newCode
required
string

The new provisionable object code to be used.

oldCode
required
string

The old provisionable object code to be changed.

Responses

Request samples

Content type
application/json
{
  • "newCode": "POC2",
  • "oldCode": "POC1"
}

Qualification Tag

Resources related to the management of Qualification Tags.

Create a Qualification Tag

Creates a new Qualification Tag. [Rev 1.39]

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
name
required
string

Name of the qualification tag.

Responses

Request samples

Content type
application/json
{
  • "name": "Example Name"
}

Response samples

Content type
application/json
{
  • "createDate": "2024-07-16T09:18:05.6059371-04:00",
  • "createdByUser": "jdoe",
  • "lastModifiedDate": "2024-07-16T09:18:05.6059371-04:00",
  • "lastModifiedUser": "jdoe",
  • "name": "Example Name",
  • "qualificationTagID": 1
}

Search Qualification Tags

Search for Qualification Tags in the system. [Rev 1.39]

Available Fields

The following is a list of fields for a Qualification Tag and how they can be used within a search.

  • Filterable : QualificationTagID, Name, CreateDate, CreatedByUser, LastModifiedDate, LastModifiedUser
  • Sortable : QualificationTagID, Name, CreateDate, CreatedByUser, LastModifiedDate, LastModifiedUser
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Get a Qualification Tag

Get a Qualification Tag. [Rev 1.39]

path Parameters
qualificationTagID
required
integer

Unique ID of the qualification tag to retrieve.

Responses

Response samples

Content type
application/json
{
  • "createDate": "2024-07-16T09:18:05.6059371-04:00",
  • "createdByUser": "jdoe",
  • "lastModifiedDate": "2024-07-16T09:18:05.6059371-04:00",
  • "lastModifiedUser": "jdoe",
  • "name": "Example Name",
  • "qualificationTagID": 1
}

Delete a Qualification Tag

Deletes a Qualification Tag. [Rev 1.40]

path Parameters
qualificationTagID
required
integer

Unique ID of the qualification tag to delete.

Responses

Update a Qualification Tag

Updates a specific Qualification Tag by ID. [Rev 1.39]

Note

  • This operation uses the JSON Patch document structure for specifying updates to a Qualification Tag, which you can read more about here: JSON Patch (RFC 6902).

  • After JSON Patch validation, field validation is performed the same as Create a Qualification Tag.

Patchable Fields

Allowed patch operations for each patchable property of a device.

  • name : replace
Authorizations:
SWT
path Parameters
qualificationTagID
required
string

Unique ID for the Qualification Tag.

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
Array
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Get Associated Serviceable Addresses for a Qualification Tag

Search for Qualification Tags in the system. [Rev 1.39]

Available Fields

The following is a list of fields for a Serviceable Address and how they can be used within a search.

  • Filterable : ServiceableAddressID, FullAddress
  • Sortable : ServiceableAddressID, FullAddress
path Parameters
qualificationTagID
required
integer

Unique ID of the qualification tag to retrieve assigned serviceable addresses.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Serviceable Address

Resources related to the management of Serviceable Addresses.

Creates or Updates a Serviceable Address

Creates or updates a serviceable address. If the address already exists, it will be updated with the provided details. If it does not exist, a new serviceable address will be created. [Rev 1.40]

header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
AliasFlag
boolean

Indicates if the serviceable address is an alias for another address.

ExternalReference
string

External reference identifier for the serviceable address.

StreetNumber
string

Street number of the serviceable address.

StreetDirectionPrefix
string

Directional prefix for the street (e.g., N, S, E, W).

StreetName
string

Name of the street.

Thoroughfare
string

Thoroughfare name for the serviceable address.

StreetDirectionSuffix
string

Directional suffix for the street (e.g., NE, SW).

Designator1
string

Designator for the street (e.g., Ave, Blvd).

Designator1Value
string

Value for the designator (e.g., Avenue, Boulevard).

City
string

City for the serviceable address.

State
string

State for the serviceable address.

Zip
string

ZIP code for the serviceable address.

Zip4
string

ZIP+4 code for the serviceable address.

CountyFIPS
string

FIPS code for the county.

County
string

Name of the county.

ResBusIndicator
string

Indicates if the address is residential or business.

SecondaryFlag
boolean

Indicates if the address has secondary units (e.g., apartments).

ContainsSecondaries
boolean

Indicates if the address contains secondary units (e.g., apartments).

SecondaryCount
integer

Number of secondary units (e.g., apartments) at the address.

ParentExternalReference
string

External reference identifier for the parent address (if applicable).

Latitude
number <float>

Latitude coordinate of the serviceable address.

Longitude
number <float>

Longitude coordinate of the serviceable address.

CensusBlock
string

Census block for the serviceable address.

ServiceAvailable
boolean

Indicates if service is available at the address.

AvailableDate
string <date-time>

Date when service becomes available (if applicable).

PricingZone
string

Zone reference to the Pricing zone for the serviceable address.

TechRegion
string

Technology region for the serviceable address.

Array of objects (CreateQualificationTag)

Qualification tags for the serviceable address.

Responses

Request samples

Content type
application/json
{
  • "AliasFlag": true,
  • "ExternalReference": "EXT-12345",
  • "StreetNumber": "123",
  • "StreetDirectionPrefix": "N",
  • "StreetName": "Main St",
  • "Thoroughfare": "Main",
  • "StreetDirectionSuffix": "NE",
  • "Designator1": "Ave",
  • "Designator1Value": "Avenue",
  • "City": "Anytown",
  • "State": "CA",
  • "Zip": "12345",
  • "Zip4": "12345-6789",
  • "CountyFIPS": "067",
  • "County": "Los Angeles County",
  • "ResBusIndicator": "Residential",
  • "SecondaryFlag": false,
  • "ContainsSecondaries": false,
  • "SecondaryCount": 0,
  • "ParentExternalReference": "EXT-54321",
  • "Latitude": 34.0522,
  • "Longitude": -118.2437,
  • "CensusBlock": "123456789001",
  • "ServiceAvailable": true,
  • "AvailableDate": "2023-01-01T00:00:00Z",
  • "PricingZone": "Zone A",
  • "TechRegion": "Region A",
  • "QualificationTags": [
    ]
}

Response samples

Content type
application/json
{
  • "ServiceableAddressID": 12345,
  • "ExternalReference": "EXT-12345",
  • "StreetNumber": "123",
  • "StreetDirectionPrefix": "N",
  • "StreetName": "Main St",
  • "Thoroughfare": "Main Street",
  • "StreetDirectionSuffix": "NE",
  • "Designator1": "Ave",
  • "Designator1Value": "Avenue",
  • "City": "Anytown",
  • "State": "CA",
  • "Zip": "12345",
  • "Zip4": "12345-6789",
  • "CountyFIPS": "06037",
  • "County": "Los Angeles County",
  • "ResBusIndicator": "Residential",
  • "SecondaryFlag": false,
  • "ContainsSecondaries": false,
  • "SecondaryCount": 0,
  • "ParentExternalReference": "EXT-54321",
  • "Latitude": 34.0522,
  • "Longitude": -118.2437,
  • "CensusBlock": "123456789001",
  • "ServiceAvailable": true,
  • "AvailableDate": "2023-01-01T00:00:00Z",
  • "NPANXXZoneID": 123,
  • "TechRegion": "Region A",
  • "FullAddress": "123 N Main St, Anytown, CA 12345",
  • "PricingZone": {
    },
  • "CreateDate": "2023-01-01T00:00:00Z",
  • "LastModifiedDate": "2023-01-01T00:00:00Z",
  • "QualificationTags": [
    ]
}

Search Serviceable Addresses

Search for Serviceable Addresses in the system. [Rev 1.40]

Available Fields

The following is a list of fields for a Serviceable Address and how they can be used within a search.

  • Filterable : ServiceableAddressID, ExternalReference, StreetNumber, StreetDirectionPrefix, StreetName, Thoroughfare, StreetDirectionSuffix, Designator1, Designator1Value, City, State, Zip, Zip4, CountyFIPS, County, ResBusIndicator, SecondaryFlag, ContainsSecondaries, SecondaryCount, ParentExternalReference, Latitude, Longitude, CensusBlock, ServiceAvailable, AvailableDate, NPANXXZoneID, TechRegion, FullAddress
  • Sortable : ServiceableAddressID, ExternalReference, StreetNumber, StreetDirectionPrefix, StreetName, Thoroughfare, StreetDirectionSuffix, Designator1, Designator1Value, City, State, Zip, Zip4, CountyFIPS, County, ResBusIndicator, SecondaryFlag, ContainsSecondaries, SecondaryCount, ParentExternalReference, Latitude, Longitude, CensusBlock, ServiceAvailable, AvailableDate, NPANXXZoneID, TechRegion, FullAddress
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Get Serviceable Address

Retrieves a specific serviceable address by its unique identifier. [Rev 1.41]

path Parameters
id
required
integer

The unique identifier of the serviceable address.

Responses

Response samples

Content type
application/json
{
  • "ServiceableAddressID": 12345,
  • "ExternalReference": "EXT-12345",
  • "StreetNumber": "123",
  • "StreetDirectionPrefix": "N",
  • "StreetName": "Main St",
  • "Thoroughfare": "Main Street",
  • "StreetDirectionSuffix": "NE",
  • "Designator1": "Ave",
  • "Designator1Value": "Avenue",
  • "City": "Anytown",
  • "State": "CA",
  • "Zip": "12345",
  • "Zip4": "12345-6789",
  • "CountyFIPS": "06037",
  • "County": "Los Angeles County",
  • "ResBusIndicator": "Residential",
  • "SecondaryFlag": false,
  • "ContainsSecondaries": false,
  • "SecondaryCount": 0,
  • "ParentExternalReference": "EXT-54321",
  • "Latitude": 34.0522,
  • "Longitude": -118.2437,
  • "CensusBlock": "123456789001",
  • "ServiceAvailable": true,
  • "AvailableDate": "2023-01-01T00:00:00Z",
  • "NPANXXZoneID": 123,
  • "TechRegion": "Region A",
  • "FullAddress": "123 N Main St, Anytown, CA 12345",
  • "PricingZone": {
    },
  • "CreateDate": "2023-01-01T00:00:00Z",
  • "LastModifiedDate": "2023-01-01T00:00:00Z",
  • "QualificationTags": [
    ]
}

Start As Option

Resources related to Start As Options.

Search Start As Options

Search for Start As Options in the system. [Rev 1.08]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : startAsOptionID
  • Sortable : name
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Get a Start As Option

Retrieve a specific Start As Option by ID. [Rev 1.08]

Authorizations:
SWT
path Parameters
startAsOptionID
required
integer

Unique ID of the Starting As Option to retrieve.

Responses

Response samples

Content type
application/json
{
  • "name": "Order",
  • "startAsOptionID": 2
}

Starting Action

Resources related to Starting Actions.

Search Starting Actions

Search for Starting Actions in the system. [Rev 1.08]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : startingActionID
  • Sortable : name
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Starting Block

Resources related to Starting Blocks.

Create Starting Block

Create a Starting Block. [Rev 1.07]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
object (AdditionalActionInfo)
allowAccountLevelActions
boolean

Determines whether Account Level actions are allowed for this Starting Block. The value will default to false if no value is provided. [Rev 1.08]

allowAddItem
boolean

Determines whether this Starting Block allows adding items. The value will default to false if no value is provided. [Rev 1.08]

allowAddService
boolean

Determines whether this Starting Block allows adding services. The value will default to false if no value is provided. [Rev 1.08]

allowBillPayment
boolean

Determines whether this Starting Block allows bill payments. The value will default to false if no value is provided. [Rev 1.22]

allowDeposit
boolean

Determines whether this Starting Block allows deposits. The value will default to false if no value is provided. [Rev 1.26]

allowEmailOnDemand
boolean

Determines whether this Starting Block allows a user to email details of a transaction on demand. The value will default to false if no value is provided. [Rev 1.14]

allowEmailOnlyAfterTxnSubmitted
boolean

Determines whether this Starting Block limits emailing details on demand to only submitted transactions. The value will default to false if no value is provided. [Rev 1.14]

allowForAccount
boolean

Determines whether this Starting Block will be displayed on the account of a customer. The value will default to false if no value is provided. [Rev 1.08]

allowForOrders
boolean

Determines whether this Starting Block will be displayed while creating an order. The value will default to false if no value is provided. [Rev 1.08]

allowForService
boolean

Determines whether this Starting Block will be displayed on the service of a customer. The value will default to false if no value is provided. [Rev 1.08]

allowForServiceActivationPortal
boolean

Determines whether this Starting Block will be displayed in the Service Activation Portal. [Rev 1.36]

allowModifyItem
boolean

Determines whether this Starting Block allows modifying items. The value will default to false if no value is provided. [Rev 1.08]

allowModifyService
boolean

Determines whether this Starting Block allows modifying services. The value will default to false if no value is provided. [Rev 1.08]

assignmentTemplateID
integer

Unique identifier for the Assignment Template associated to this Starting Block. [Rev 1.36]

object (Behavior)
caption
string

Brief description of the Starting Block intended to help users choose the correct one.

description
string

Description of the Starting Block intended to explain its full intent to admin users.

emailFromAddress
string

The From amail address that will be used for emails sent for transactions started by this Starting Block. [Rev 1.14]

Note

  • emailFromAddress is required for emailOptionID 2 'Message Email'.
  • emailFromAddress is ignored for emailOptionID 3 'Notification Email'.
emailOptionID
integer
Enum: "1 - No Email [Default]" "2 - Message Email [Normal]" "3 - Notification Email [No Reply]"

Unique identifier of the system-defined option indicating what type of email this Starting Block can generate, if any. [Rev 1.14]

emailSubject
string

The Subject text that will be used for emails sent after submitting a transaction that was started by this Starting Block. [Rev 1.14]"

Note

  • emailSubject is required when an option to email is configured in the Starting Block.
  • emailSubject is ignored for on demand emails sent before a transaction has been submiitted. The subject will instead indicate that the transaction is still being assembled.
endDate
string <date-time>

When configured, this is the last date and time the Starting Block is available to be used.

invoiceItemsToPrint
string
Default: "AllItems"
Enum: "AllItems" "DirectInvoiceItems"

Defines what items should be printed on a direct invoice printed using this starting block. [Rev 1.16]

Note

  • invoiceItemsToPrint is ignored if the networkPrinterTemplateID is null.
  • invoiceItemsToPrint is ignored if the startAsOptionID is not 3 'Direct Invoice'.
isRegisterRequired
boolean

Specifies whether a register is required for this Starting Block. [Rev 1.09]

locationID
integer

Unique identifier of the location associated with the register of the transaction. [Rev 1.09]

Note

  • Location must be the same as this Starting Block's register location.
logo
string

The Base64 encoded string for the document logo. [Rev 1.16]

Note

  • logo is ignored if the networkPrinterTemplateID is null.
logoFileName
string

The name of the logo file, including the file extension. [Rev 1.16]

Note

  • logoFileName is ignored if the networkPrinterTemplateID is null.
name
required
string

Name of the Starting Block, which must be unique across the system.

networkPrinterTemplateID
integer

Unique identifier for the document template to be used for printing the full-size network receipt. [Rev 1.16]

offeringID
integer

Unique identifier for the Offering associated to this Starting Block. [Rev 1.36]

Note

  • offeringID is required if AllowForServiceActivationPortal is true.
orderTypeID
integer

Unique identifier of a configured Order Type to be used by this Starting Block.

promptForEmailUponSubmit
boolean

Determines whether this Starting Block will prompt a user to email details upon submit of a transaction. The value will default to false if no value is provided. [Rev 1.14]

registerID
integer

Unique identifier of the register used for the transaction. [Rev 1.09]

Note

  • The register must be at the same location as this Starting Block.
saleFooter
string

Text to be shown at the foot of the document printed for a sale. [Rev 1.16]

Note

  • saleFooter is ignored if the networkPrinterTemplateID is null.
startAsOptionID
required
integer
Enum: "1 - Order" "2 - Sale" "3 - Direct Invoice"

Unique identifier of the system-defined option indicating what this Starting Block is intended to create.

startDate
string <date-time>

When configured, this is the first date and time the Starting Block is available to be used.

startingActionID
integer

Unique identifier of the Starting Action. [Rev 1.08]

Responses

Request samples

Content type
application/json
{
  • "additionalActionInfo": {
    },
  • "allowAccountLevelActions": false,
  • "allowAddItem": false,
  • "allowAddService": false,
  • "allowBillPayment": false,
  • "allowDeposit": false,
  • "allowEmailOnDemand": false,
  • "allowEmailOnlyAfterTxnSubmitted": false,
  • "allowForAccount": false,
  • "allowForOrders": false,
  • "allowForService": false,
  • "allowForServiceActivationPortal": false,
  • "allowModifyItem": false,
  • "allowModifyService": false,
  • "assignmentTemplateID": 1014,
  • "behavior": {
    },
  • "caption": "Primary Replacement Starting Block",
  • "description": "This is the primary replacement Starting Block. It is for a damaged, lost, or stolen device that is still under warranty. There is another Starting Block for out-of-warranty replacement and may be others in the future.",
  • "emailFromAddress": "mystore@yahoo.com",
  • "emailOptionID": 2,
  • "emailSubject": "Details from your recent transaction",
  • "endDate": "2020-04-21 12:32:52",
  • "invoiceItemsToPrint": "AllItems",
  • "isRegisterRequired": false,
  • "locationID": 2,
  • "logo": "iVBORw0KGgoAA...",
  • "logoFileName": "Fog.gif",
  • "name": "Replace Device",
  • "networkPrinterTemplateID": 3,
  • "offeringID": 13,
  • "orderTypeID": 1014,
  • "promptForEmailUponSubmit": false,
  • "registerID": 2,
  • "saleFooter": "Returns & exchanges must meet the following requirements: purchased within 60 days.",
  • "startAsOptionID": 2,
  • "startDate": "2019-04-21 11:33:52",
  • "startingActionID": 1
}

Response samples

Content type
application/json
{
  • "additionalActionInfo": {
    },
  • "allowAccountLevelActions": false,
  • "allowAddItem": false,
  • "allowAddService": false,
  • "allowBillPayment": true,
  • "allowDeposit": false,
  • "allowEmailOnDemand": false,
  • "allowEmailOnlyAfterTxnSubmitted": false,
  • "allowForAccount": false,
  • "allowForOrders": false,
  • "allowForService": false,
  • "allowForServiceActivationPortal": false,
  • "allowModifyItem": false,
  • "allowModifyService": false,
  • "assignmentTemplate": "Contract Filters",
  • "assignmentTemplateID": 1014,
  • "behavior": {
    },
  • "caption": "Get a replacement for a damaged, lost, or stolen device that is still under warranty.",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "jdoe",
  • "description": "This is the primary replacement Starting Block. It is for a damaged, lost, or stolen device that is still under warranty. There is another Starting Block for out-of-warranty replacement and may be others in the future.",
  • "emailFromAddress": "mystore@yahoo.com",
  • "emailOption": "Message Email",
  • "emailOptionID": 2,
  • "emailSubject": "Details from your recent transaction",
  • "endDate": "2020-04-21 12:32:52",
  • "invoiceItemsToPrint": "AllItems",
  • "isRegisterRequired": false,
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "string",
  • "location": "Rochester",
  • "locationID": 2,
  • "logo": "iVBORw0KGgoAA...",
  • "logoFileName": "Fog.gif",
  • "name": "Replace Device",
  • "networkPrinterTemplate": "NW Receipt",
  • "networkPrinterTemplateID": 3,
  • "offering": "Essential Bundle Offering",
  • "offeringID": 13,
  • "orderType": "Retail Only Exchange",
  • "orderTypeID": 1014,
  • "promptForEmailUponSubmit": false,
  • "register": "Global",
  • "registerID": 2,
  • "saleFooter": "Returns & exchanges must meet the following requirements: purchased within 60 days.",
  • "startAsOption": "Sale",
  • "startAsOptionID": 2,
  • "startDate": "2019-04-21 11:33:52",
  • "startingAction": "Disconnect Customer",
  • "startingActionID": 1,
  • "startingBlockID": 1
}

Search Starting Blocks

Search for Starting Blocks in the system. [Rev 1.07]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : allowForAccount, allowForOrders, allowForService, caption, endDate, name, offeringID, orderTypeID, startAsOptionID, startDate, startingActionID, startingBlockID [Rev 1.37]
  • Sortable : caption, endDate, name, orderType, startAsOption, startDate, startingAction
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Get a Starting Block

Retrieve a specific Starting Block by ID. [Rev 1.07]

Authorizations:
SWT
path Parameters
startingBlockID
required
integer

Unique ID of the Starting Block to retrieve.

Responses

Response samples

Content type
application/json
{
  • "additionalActionInfo": {
    },
  • "allowAccountLevelActions": false,
  • "allowAddItem": false,
  • "allowAddService": false,
  • "allowBillPayment": true,
  • "allowDeposit": false,
  • "allowEmailOnDemand": false,
  • "allowEmailOnlyAfterTxnSubmitted": false,
  • "allowForAccount": false,
  • "allowForOrders": false,
  • "allowForService": false,
  • "allowForServiceActivationPortal": false,
  • "allowModifyItem": false,
  • "allowModifyService": false,
  • "assignmentTemplate": "Contract Filters",
  • "assignmentTemplateID": 1014,
  • "behavior": {
    },
  • "caption": "Get a replacement for a damaged, lost, or stolen device that is still under warranty.",
  • "createDate": "2019-08-24T14:15:22Z",
  • "createUser": "jdoe",
  • "description": "This is the primary replacement Starting Block. It is for a damaged, lost, or stolen device that is still under warranty. There is another Starting Block for out-of-warranty replacement and may be others in the future.",
  • "emailFromAddress": "mystore@yahoo.com",
  • "emailOption": "Message Email",
  • "emailOptionID": 2,
  • "emailSubject": "Details from your recent transaction",
  • "endDate": "2020-04-21 12:32:52",
  • "invoiceItemsToPrint": "AllItems",
  • "isRegisterRequired": false,
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "lastModifiedUser": "string",
  • "location": "Rochester",
  • "locationID": 2,
  • "logo": "iVBORw0KGgoAA...",
  • "logoFileName": "Fog.gif",
  • "name": "Replace Device",
  • "networkPrinterTemplate": "NW Receipt",
  • "networkPrinterTemplateID": 3,
  • "offering": "Essential Bundle Offering",
  • "offeringID": 13,
  • "orderType": "Retail Only Exchange",
  • "orderTypeID": 1014,
  • "promptForEmailUponSubmit": false,
  • "register": "Global",
  • "registerID": 2,
  • "saleFooter": "Returns & exchanges must meet the following requirements: purchased within 60 days.",
  • "startAsOption": "Sale",
  • "startAsOptionID": 2,
  • "startDate": "2019-04-21 11:33:52",
  • "startingAction": "Disconnect Customer",
  • "startingActionID": 1,
  • "startingBlockID": 1
}

Update a Starting Block

Update a specific Starting Block by ID. [Rev 1.07]

Note

  • This operation uses the JSON Patch document structure for specifying updates to a Protection Plan Profile, which you can read more about here: JSON Patch (RFC 6902).

  • After JSON Patch validation, field validation is performed the same as Create a Starting Block.

Patchable Fields

Allowed patch operations for each patchable property of a Starting Block.

  • additionalActionInfo/excludeFinalBilledOneTimeCharges : add, remove, replace [Rev 1.20]

    Note

    • excludeFinalBilledOneTimeCharges is ignored if the startingActionID is not 'Reconnect Customer' or 'Reconnect Service'.
    • excludeFinalBilledOneTimeCharges is ignored if reconnectFinalBilledItems is false.

  • additionalActionInfo/inventoryStatusID : add, remove, replace [Rev 1.23]

    Note

    • inventoryStatusID is ignored if the startingActionID is not 'Return Item'.

  • additionalActionInfo/isPortingOut : add, remove, replace [Rev 1.20]

    Note

    • isPortingOut is ignored if the startingActionID is not 'Disconnect Service'
    • isPortingOut is ignored if the reasonID is not configured

  • additionalActionInfo/reasonID : add, remove, replace [Rev 1.20]

    Note

    • reasonID is ignored if startingActionID is not 'Disconnect Customer', 'Disconnect Service', 'Hotline Service', 'Redirect Service', 'Restore Service', 'Suspend Service', or 'Swap Equipment'.
    • The Change Type of the Reason must be valid for the Starting Action.

  • additionalActionInfo/reconnectFinalBilledItems : add, remove, replace [Rev 1.20]

    Note

    • reconnectFinalBilledItems is ignored if startingActionID is not 'Reconnect Customer' or 'Reconnect Service'.

  • additionalActionInfo/reconnectMethodPrimary : add, remove, replace [Rev 1.20]

    Note

    • reconnectMethodPrimary is ignored if startingActionID is not 'Reconnect Customer' or 'Reconnect Service'.

  • additionalActionInfo/reconnectMethodSecondary : add, remove, replace [Rev 1.20]

    Note

    • reconnectMethodSecondary is ignored if startingActionID is not 'Reconnect Customer' or 'Reconnect Service'.

  • additionalActionInfo/restartFinalBilledBillingCharges : add, remove, replace [Rev 1.20]

    Note

    • restartFinalBilledBillingCharges is ignored if startingActionID is not 'Reconnect Customer' or 'Reconnect Service'.
    • restartFinalBilledBillingCharges is ignored if reconnectFinalBilledItems is false.

  • additionalActionInfo/returnReasonID : add, remove, replace [Rev 1.23]

    Note

    • returnReasonID is ignored if the startingActionID is not 'Return Item'.

  • additionalActionInfo/serviceNumberOwnerID : add, remove, replace [Rev 1.20]

    Note

    • serviceNumberOwnerID is ignored if the startingActionID is not 'Disconnect Service'.
    • serviceNumberOwnerID is ignored if isPortingOut is false.
    • The ServiceNumberOwner must support Porting To.

  • allowAccountLevelActions : add, replace [Rev 1.08]

  • allowAddItem : add, replace [Rev 1.08]

  • allowAddService : add, replace [Rev 1.08]

  • allowBillPayment : add, replace, remove [Rev 1.22]

  • allowDeposit : add, replace, remove [Rev 1.26]

  • allowEmailOnDemand : add, replace [Rev 1.14]

  • allowEmailOnlyAfterTxnSubmitted : add, replace [Rev 1.14]

  • allowForAccount : add, replace [Rev 1.08]

  • allowForOrders : add, replace [Rev 1.08]

  • allowForService : add, replace [Rev 1.08]

  • allowForServiceActivationPortal : add, replace [Rev 1.36]

  • allowModifyItem : add, replace [Rev 1.08]

  • allowModifyService : add, replace [Rev 1.08]

  • assignmentTemplateID : add, remove, replace [Rev 1.36]

  • behavior/performCreditEvaluation: add, remove, replace [Rev 1.26]

  • behavior/skipNewTransactionPage: add, remove, replace [Rev 1.20]

  • behavior/skipNewTransactionPage: add, remove, replace [Rev 1.20]

  • caption : add, remove, replace

  • description : add, remove, replace

  • emailFromAddress : add, remove, replace [Rev 1.14]

    Note

    • emailFromAddress is required for emailOptionID 2 'Message Email'.
    • emailFromAddress is ignored for emailOptionID 3 'Notification Email'.

  • emailOptionID : add, replace [Rev 1.14]

  • emailSubject : add, remove, replace [Rev 1.14]

    Note

    • emailSubject is required when an option to email is configured in the Starting Block.
    • emailSubject is ignored for on demand emails sent before a transaction has been submiitted. The subject will instead indicate that the transaction is still being assembled.

  • endDate : add, remove, replace

  • invoiceItemsToPrint: add, remove, replace [Rev 1.16]

    Note

    • invoiceItemsToPrint is ignored if the networkPrinterTemplateID is null.
    • invoiceItemsToPrint is ignored if the startAsOptionID is not 3 'Direct Invoice'.

  • isRegisterRequired: add, remove, replace [Rev 1.09]

  • locationID: add, remove, replace [Rev 1.09]

    Note

    • Location must be the same as the Starting Block's register location.

  • logo: add, remove, replace [Rev 1.16]

    Note

    • logo is ignored if the networkPrinterTemplateID is null.

  • logoFileName: add, remove, replace [Rev 1.16]

    Note

    • logoFileName is ignored if the networkPrinterTemplateID is null.

  • name : add, replace

  • networkPrinterTemplateID: add, remove, replace [Rev 1.16]

  • promptForEmailUponSubmit : add, replace [Rev 1.14]

  • offeringID : add, remove, replace [Rev 1.36]

    Note

    • offeringID is required if AllowForServiceActivationPortal is true.

  • orderTypeID : add, remove, replace

  • registerID: add, remove, replace [Rev 1.09]

    Note

    • The register must be at the same location as the Starting Block.

  • saleFooter : add, remove, replace [Rev 1.16]

    Note

    • saleFooter is ignored if the networkPrinterTemplateID is null.

  • startAsOptionID : add, replace

  • startDate : add, remove, replace

  • startingActionID: add, remove, replace [Rev 1.08]

Authorizations:
SWT
path Parameters
startingBlockID
required
integer

Unique ID of the Starting Block to update.

Request Body schema: application/json
Array
op
required
string (op)
Enum: "add" "replace" "remove"

The type of JSON Patch operation being requested.

path
required
string

Path within the JSON document that should be modified.

value
string

If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Search Starting Block Browse Tag Associations

Search for Browse Tags associated to a Starting Block in the system. [Rev 1.35]

Available Fields

The following indicates how each field can be used within the search.

  • Filterable : browseTagCategory, browseTagCategoryID, browseTagID, name
  • Sortable : browseTagCategoryID, browseTagID, name
Authorizations:
SWT
path Parameters
startingBlockID
required
number
Example: 1

Unique identifier of the Starting Block to retrieve Browse Tags for.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
string
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 50,
  • "value": [
    ],
  • "@nextLink": "https://api.idibilling.com/<service>/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50"
}

Associate Browse Tags to Starting Block

Associate Browse Tags to a Starting Block. [Rev 1.35]

Authorizations:
SWT
path Parameters
startingBlockID
required
number
Example: 1

Unique identifier of the Starting Block to associate Browse Tags to.

Request Body schema: application/json
Array
browseTagID
required
integer

Unique identifier of the Browse Tag to associate to the Starting Block.

remove
boolean

Indicate that the Browse Tag association should be removed, instead of added.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Update Outcome Code

Update all variable links using an existing outcome code, associated with a variable code, to use a new outcome code. [Rev 1.10]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
newOutcomeCode
required
string

The new outcome code to be used.

oldOutcomeCode
required
string

The old outcome code to be changed.

variableCode
required
string

The variable code, the old outcome code is associated with.

Responses

Request samples

Content type
application/json
{
  • "newOutcomeCode": "V2",
  • "oldOutcomeCode": "V1",
  • "variableCode": "string"
}

Update Variable Code

Update all variable links using an existing Variable code to use a new Variable code. [Rev 1.10]

Authorizations:
SWT
header Parameters
Content-Type
required
string
Example: application/json
Request Body schema: application/json
newCode
required
string

The new code to be used.

oldCode
required
string

The old code to be changed.

Responses

Request samples

Content type
application/json
{
  • "newCode": "V2",
  • "oldCode": "V1"
}

Release Notes

Release Notes 1.41

  • Added Create Service Address Link POST api/serviceableAddress/{serviceableAddressID}/serviceAddress to create a link between a serviceable address and a service address.
  • Updated Search Serviceable Addresses response to include fully populated Pricing Zone if foreign key present.
  • Added Get Serviceable Address GET api/serviceableAddress/{serviceableAddressID} to retrieve a specific serviceable address by ID.
  • Added Search Service Address Links GET api/serviceableAddress/serviceAddress to retrieve all service address links for a serviceable address.
  • Added Delete Service Address Link DELETE api/serviceableAddress/{serviceableAddressID}/serviceAddress/{serviceAddressID} to delete a link between a serviceable address and a service address.

Release Notes 1.40

Release Notes 1.39

Release Notes 1.38

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.37

Release Notes 1.36

Release Notes 1.35

Release Notes 1.34

Release Notes 1.33

Release Notes 1.32

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.31

Release Notes 1.30

Release Notes 1.29

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.28

Release Notes 1.27

Release Notes 1.26

Release Notes 1.25

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.24

Release Notes 1.23

Release Notes 1.22

Release Notes 1.21

Release Notes 1.20

Release Notes 1.19

Release Notes 1.18

Release Notes 1.17

Release Notes 1.16

Release Notes 1.15

Release Notes 1.14

  • Added allowEmailOnDemand, allowEmailOnlyAfterTxnSubmitted, emailFromAddress, emailOption, emailOptionID, emailSubject, PromptForEmailUponSubmit fields to starting blocks in

Release Notes 1.13

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.12

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.11

Release Notes 1.10

Release Notes 1.09

Release Notes 1.08

Release Notes 1.07

Release Notes 1.06

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.05

Release Notes 1.04

Release Notes 1.03

Release Notes 1.02

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.01

  • Note: Internal changes were applied to this release. There were no external API changes.

Release Notes 1.00

  • Initial Release